/*******************************************************************************
 * Copyright IBM Corp. and others 2000
 *
 * This program and the accompanying materials are made available under
 * the terms of the Eclipse Public License 2.0 which accompanies this
 * distribution and is available at https://www.eclipse.org/legal/epl-2.0/
 * or the Apache License, Version 2.0 which accompanies this distribution and
 * is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * This Source Code may also be made available under the following
 * Secondary Licenses when the conditions for such availability set
 * forth in the Eclipse Public License, v. 2.0 are satisfied: GNU
 * General Public License, version 2 with the GNU Classpath
 * Exception [1] and GNU General Public License, version 2 with the
 * OpenJDK Assembly Exception [2].
 *
 * [1] https://www.gnu.org/software/classpath/license.html
 * [2] https://openjdk.org/legal/assembly-exception.html
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0 OR GPL-2.0-only WITH OpenJDK-assembly-exception-1.0
 *******************************************************************************/
#ifndef JPROFILINGBLOCK_INCL
#define JPROFILINGBLOCK_INCL

#ifdef OMRZTPF
#define __TPF_DO_NOT_MAP_ATOE_REMOVE
#endif

#include <stdint.h>
#include <queue>
#include <vector>
#include "optimizer/Optimization.hpp"
#include "optimizer/OptimizationManager.hpp"

namespace TR { class Block; }
namespace TR { class BlockChecklist; }
namespace OMR { class Logger; }
class TR_BlockFrequencyInfo;

class BlockParents;

class TR_JProfilingBlock : public TR::Optimization
   {
   protected:
   typedef std::pair<int32_t, TR::Block*> BlockQueueItem;
   typedef TR::typed_allocator<BlockQueueItem, TR::Region&> BlockContainerAllocator;
   typedef std::vector<BlockQueueItem, BlockContainerAllocator> BlockQueueContainer;
   typedef std::greater<BlockQueueItem> BlockQueueCompare;
   typedef std::priority_queue<BlockQueueItem,BlockQueueContainer,BlockQueueCompare> BlockPriorityQueue;

   public:
   static int32_t nestedLoopRecompileThreshold;
   static int32_t loopRecompileThreshold;
   static int32_t recompileThreshold;
   TR_JProfilingBlock(TR::OptimizationManager *manager)
      : TR::Optimization(manager)
      {}
   static TR::Optimization *create(TR::OptimizationManager *manager)
      {
      return new (manager->allocator()) TR_JProfilingBlock(manager);
      }

   virtual int32_t perform();
   virtual const char * optDetailString() const throw();
   protected:
   void computeMinimumSpanningTree(BlockParents &parents, BlockPriorityQueue &Q, TR::StackMemoryRegion &stackMemoryRegion);
   int32_t processCFGForCounting(BlockParents &parent, TR::BlockChecklist &countedBlocks, TR::CFGEdge &loopBack);
   TR_BlockFrequencyInfo *initRecompDataStructures();
   void dumpCounterDependencies(OMR::Logger *log, TR_BitVector **componentCounters);
   void addRecompilationTests(TR_BlockFrequencyInfo *blockFrequencyInfo);
   };

#endif
